@iota/transaction-converter

@iota/transaction-converter

Methods for calculating transaction hashes and converting transaction objects to transaction trytes and back.

Installation

Install using npm:

npm install @iota/transaction-converter

or using yarn:

yarn add @iota/transaction-converter

API Reference

• transaction-converter

  • ~asTransactionTrytes(transactions)

  • ~asTransactionObject(trytes)

  • ~asTransactionObjects([hashes])

  • ~transactionObjectsMapper(trytes)

transaction-converter~asTransactionTrytes(transactions)

Param	Type	Description
transactions	Transaction | Array.<Transaction>	Transaction object(s)

Converts a transaction object or a list of those into transaction trytes.

Returns: Trytes | Array.<Trytes> - Transaction trytes

transaction-converter~asTransactionObject(trytes)

Param	Type	Description
trytes	Trytes	Transaction trytes

Converts transaction trytes of 2673 trytes into a transaction object.

Returns: Transaction - Transaction object

transaction-converter~asTransactionObjects([hashes])

Param	Type	Description
[hashes]	Array.<Hash>	Optional list of known hashes. Known hashes are directly mapped to transaction objects, otherwise all hashes are being recalculated.

Converts a list of transaction trytes into list of transaction objects. Accepts a list of hashes and returns a mapper. In cases hashes are given, the mapper function map them to converted objects.

Returns: function - transactionObjectsMapper

transaction-converter~transactionObjectsMapper(trytes)

Param	Type	Description
trytes	Array.<Trytes>	List of transaction trytes to convert

Maps the list of given hashes to a list of converted transaction objects.

Returns: Array.<Transaction> - List of transaction objects with hashes